Skip to content

NH-4000 - Prepare release of v5.0 #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 10, 2017

Conversation

fredericDelaporte
Copy link
Member

@fredericDelaporte fredericDelaporte commented Sep 19, 2017

NH-4000 - Proposed changes to release notes for v5.0.

NH-3845 not included as it does not seem to be fully fixed, see #553.

NH-3945 (Antlr3 upgrade) is labeled with "possible breaking changes", but I was unable to determine them.

Elaborated from the Jira list of fixed for 5.0.0. Opened issues (excepted NH-4000) have been removed from the release. (Mostly moved to 5.1, some to 6.0 or nothing.)

Test related items are identified as such, one has been dropped from the list (support of inconclusive results).

Some minor titles adjustment has been done for some issues in order for them to be more explicit. Some others should maybe be reworded, especially bugs which titles are sometimes remotely related to their actual cause.

Previous week I had review all PR with milestone:5.0 and checked their corresponding Jira, then additionally check all closed PR by merged date down to november 2016, so it should not stay some missed change.

Update: Well, thinking about it, there was a constructor change somewhere likely for some factory I have not mention, and do not remember what it was.

@fredericDelaporte
Copy link
Member Author

Since it seems not an usual practice, I have added as a separated commit some highlights. To be dropped if considered undesirable there.

About documentation, I am thinking about maybe one lacking point with async: how to mix async and lazy-loading. Users may believe lazy-loading can not be async if they do not know about NHibernateUtil.InitializeAsync (although indirectly documented since NHibernateUtil.Initialize is documented and all IO bound methods are said to have async counterparts). But adding an async section just for that (and maybe re-warning about awaiting each call) would be a bit overkill. And furthermore using such method before each potential lazy-load would be a bit "bloaty".

@fredericDelaporte
Copy link
Member Author

The ISession.GetSession(entityMode) is still in 5.0 indeed, but obsolete. So I do not mention it in breaking changes.

@hazzik
Copy link
Member

hazzik commented Sep 20, 2017

NH-3845 not included as it does not seem to be fully fixed, see #553.

The not fixed part has own JIRA issue now: NH-3947.

hazzik
hazzik previously approved these changes Sep 20, 2017
@@ -115,7 +115,7 @@ Configuration cfg = new Configuration()
obtain ADO.NET connections wherever it pleases:
</para>

<programlisting><![CDATA[IDbConnection conn = myApp.GetOpenConnection();
<programlisting><![CDATA[DbConnection conn = myApp.GetOpenConnection();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better to replace with var

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not. I have mixed feeling on that in documentation context: there is no intellisens there to check what type is the var. But in most cases it should not matter much.

releasenotes.txt Outdated
* [NH-2444] - Document linq provider
* [NH-3094] - Linq does not support unary plus and unary minus operators
* [NH-3370] - remove warning about "NHibernate.Type.CustomType -- the custom type * is not serializable"
* [NH-3386] - Linq OrderBy NewGuid
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update the wording as Guid.NewGuid() isn't yet supported.

@hazzik
Copy link
Member

hazzik commented Sep 20, 2017

Test related items are identified as such, one has been dropped from the list (support of inconclusive results).

Why?

@hazzik
Copy link
Member

hazzik commented Sep 20, 2017

@fredericDelaporte I've updated several titles of issues, so it would need to update in the release notes. Also, some issues were moved from Tasks into Improvements category.

@hazzik hazzik changed the title NH-4000 - Release notes for v5.0. NH-4000 - Prepare release of v5.0. Sep 20, 2017
@hazzik
Copy link
Member

hazzik commented Sep 20, 2017

@fredericDelaporte I completely forgot about NH-3919. We have to make it into 5.0

@fredericDelaporte
Copy link
Member Author

Why?

I was even considering dropping all tests only changes/fixes as they do not add or change features of the library. User could consider them as just noise for a release changes list. Still they give some more confidence in the library reliability. This one was not doing that. Now we can also let them all in the list: one more does not matter. Or maybe extract them to a separated list at the end (but that will cause more manual work for updating the list).

@fredericDelaporte
Copy link
Member Author

@fredericDelaporte I completely forgot about NH-3919. We have to make it into 5.0

Does not look as a small one, at least it implies to do some choices as to whether we re-align on hibernate (automatically switch to datetime 2 for sql server 2008+ instead of having to use a specific not portable type) or not. The automatic switch may cause a bunch of issues for column still using datetime, not datetime2.

If fixing that one we should fix NH-3792 by the way, and maybe the two other linked issues to.

@hazzik
Copy link
Member

hazzik commented Sep 20, 2017

I think it is fine then.

At least, I think, we need to replace DateTimeType with TimestampType, as there are a lot of confusion with cutting the milliseconds part. Because this is, potentially, a huge breaking change and we would need to postpone to 6.0 otherwise.

We will need to register Timestamp as a default type for DateTime (in TypeFactory.RegisterDefaultTypes) and change some of the dialect functions wrongly registered with DateTime, when in fact they have higher precision.

@fredericDelaporte
Copy link
Member Author

I may still give a try at NH-3919, with checking what it gives with old datetime columns. Maybe NH-3884 if implemented could give a way to revert back for users who would need it.

releasenotes.txt Outdated
@@ -3062,7 +3283,7 @@ Alpha Build 0.3.0.0
- BatcherImpl and PreparerImpl were combined and code cleaned up thanks to problems found when using Ngpsql (Martijn Boland).
- ITransaction is now responsible for joining IDbCommand to IDbTransaction instead of IBatcher - if applicable.
- Modified code to help improve performance of Drivers that don't support multiple Open DataReaders on a single IDbConnection.
- Fixed bug with hbm2net and VelocityRenderer throwing Exception (Carlos Guzm�n �lvarez & Peter Smulovics).
- Fixed bug with hbm2net and VelocityRenderer throwing Exception (Carlos Guzm�n �lvarez & Peter Smulovics).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Som unicode screw-ups

Copy link
Member Author

@fredericDelaporte fredericDelaporte Sep 21, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VS Code gotcha: microsoft/vscode#23997, they read a limited number of bytes before guessing the encoding. (At first only 512, they have increased that, but of course if they do not read the whole file they will still screw some cases...) Going to fix by switching the file to UTF8+BOM.

See microsoft/vscode@bfe1d2b, the new limit is 4096 bytes. Far to reach our first windows-1252 specific character in this file.

@hazzik hazzik changed the title NH-4000 - Prepare release of v5.0. NH-4000 - Prepare release of v5.0 Sep 21, 2017
@fredericDelaporte
Copy link
Member Author

Rebased, squashed, corruption fixed, preventing it to occur again by re-encoding to UTF8 with BOM.

<programlisting>
<![CDATA[<hibernate-mapping
</areaspec>
<programlisting><![CDATA[<hibernate-mapping
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what wrecks numbering here.

@fredericDelaporte fredericDelaporte force-pushed the NH-4000 branch 3 times, most recently from ba52c3f to b49addd Compare October 4, 2017 17:24
@fredericDelaporte
Copy link
Member Author

Release notes amended according to @oskarb e-mail.

@fredericDelaporte
Copy link
Member Author

fredericDelaporte commented Oct 6, 2017

Notes fixes squashed.

@hazzik
Copy link
Member

hazzik commented Oct 10, 2017

@fredericDelaporte are you happy with the state of the release?

Copy link
Member Author

@fredericDelaporte fredericDelaporte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

State good enough for me.

@hazzik hazzik merged commit c2c93d9 into nhibernate:master Oct 10, 2017
@igitur
Copy link
Contributor

igitur commented Oct 10, 2017

Congratulations on this milestone.

@hazzik
Copy link
Member

hazzik commented Oct 10, 2017

thanks @igitur

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants